Menus -- Synchronizer

Edit menu
You can modify the documentation files that are listed in the File List directly by means of the entries in the Edit menu.
You can also issue these anywhere in the Documentation View with the right-click Context menu.

| Note
| If you issue Edit commands before saving modifications to the documentation file(s) of the selected symbol(s), SNiFF+ will first revert the file(s) to their unmodified state before executing the command.

Synchronize menu
The following entries are available in the Synchronize menu:
Matching symbols for Obsolete symbol
This menu entry is highlighted when you select an obsolete symbol in the Documentation View. You can use this command to paste the documentation body of an obsolete symbol over the documentation body of another symbol.
When you choose this command, the Choose Symbol dialog appears. This dialog contains a list of undocumented symbols from the same documentation file in which the obsolete symbol is documented. Note that only symbols of the same type as the obsolete symbol are displayed.

To copy the documentation of the obsolete symbol (that is selected in the Documentation View), select one of the matching symbols in the match list and press the Merge button.
The documentation body of the obsolete symbol will then be pasted over the documentation body of the matching symbol.
Synchronize Documentation of Selected Files
You can use this command to update the documentation of the source files that are selected from the File List.
When you select one or more source files from the File List and then execute this command, SNiFF+

- checks to see if all the symbols in the source file(s) are documented in the corresponding documentation file(s). Documentation frames for symbols that aren't yet documented will be created. If no documentation file exists for a source file, SNiFF+ will create a new documentation file with empty (undocumented) documentation frames for all the symbols in the source file.
- SNiFF+ then checks to see whether the symbols documented in the documentation files also exist in the Symbol table. Those symbols that do not exist in the Symbol table will be marked as obsolete.

Note that there is one documentation file for both types of source files -- header and implementation.
Synchronize Documentation of Checkmarked Projects
You can use this command to update the documentation of the projects that are selected from the Project Tree.
When you checkmark one or more projects in the Project Tree and then execute this command, SNiFF+

- checks to see if all the symbols in the source files of the checkmarked projects are documented in corresponding documentation files. Documentation frames for symbols that aren't yet documented will be created. If no documentation file exists for a source file, SNiFF+ will create a new documentation file with empty (undocumented) documentation frames for all the symbols in the source file.
- SNiFF+ then checks to see whether the symbols documented in the documentation files also exist in the Symbol table. Those symbols that do not exist in the Symbol table will be marked as obsolete.

Export menu
You can use the command in the Export menu to export the documentation of whole files or whole projects, in either file or book format.
When you choose either one of these two commands, the Documentation Export dialog appears.

You can export your documentation files in either FrameMaker TM MIF (Maker Interchange Format) or HTML format. SNiFF+ uses the names of the files that you chose from the File List of the Documentation Synchronization dialog for the names of the corresponding export files (MIF files have the extension

.mif , and HTML files have the extension .htm ). By default, the export files are stored in the project directory.
Exporting your documentation files as MIF files
When you export your documentation files as MIF files, you can create a book file that contains the MIF files, or you can leave the MIF files as is.

- To create a book file, switch on the Book option button in the dialog. The contents of the Documentation Export dialog change.

- Enter the name of the book file and the extension

.book in the Book File Name field. By default, the book file is stored in the project directory.
- Press Ok to create the book file.
SNiFF+ will then create the individual MIF files and the book file.
You can then browse and edit the MIF files with any version of FrameMaker TM.
Exporting your documentation in HTML format
When you choose HTML from the Export drop-down, the contents of the Documentation Export dialog change:

- Enter the title of the HTML table of contents document in the Title field. You will then see this title at the top of the HTML table of contents document in your HTML browser.
- Enter the name of the HTML book file in the Book File Name field.
The table of contents document consists of the names of the symbols in the documentation files that you selected in the File List of the Documentation Synchronization dialog. You can jump to a symbol's documentation frame by clicking on its name in the table of contents document.

| Note
| An HTML file is created for each of the files that you selected in the File List of the Documentation Synchronization dialog. The name of the HTML file is the same as the name of its corresponding documentation file, and its extension is .htm .